Manage the categories of voucher entities.
| Name | Type | Is Mandatory |
|---|---|---|
| HierarchyNode | String | |
| ParentHierarchyNode | String | |
| HierarchyLevel | Int16 | |
| VoucherCategoryId | Int16 | |
| Label | String | |
| Identifier | String | |
| SourceId | Int16 | |
| DeletionFlag | Boolean | |
| VoucherCategoryPath | String | |
| VoucherTypeId | Int16 | |
| Amount | Decimal | |
| PointCost | Int32 | |
| LoyaltyCardTypeId | Int16 | |
| VoucherExpirationDelayDay | Int32 | |
| VoucherExpirationDelayMonth | Int32 | |
| VoucherExpirationDelayYear | Int32 | |
| Source | Source | |
| Vouchers | Collection of Voucher | |
| VoucherCategoryTranslations | Collection of VoucherCategoryTranslation | |
| VoucherType | VoucherType | |
| LoyaltyCardType | LoyaltyCardType |
Select all VoucherCategories
https://customerapi.fts-crm360.com/data/VoucherCategories()
HttpMethod : GET
Json Result :
[
{
"HierarchyNode" : "d8G48 mE8IBuDC jy8c",
"ParentHierarchyNode" : "jLIyaypgdJLz",
"HierarchyLevel" : "5",
"VoucherCategoryId" : "3",
"Label" : "KRT8oFSO 7udJvifu",
"Identifier" : "7XR TdKwFmz7NP O",
"SourceId" : "6",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "zYQ7U0sTfw5",
"VoucherTypeId" : "6",
"Amount" : "5158549.889",
"PointCost" : "1",
"LoyaltyCardTypeId" : "7",
"VoucherExpirationDelayDay" : "43",
"VoucherExpirationDelayMonth" : "87",
"VoucherExpirationDelayYear" : "73"
},
{
"HierarchyNode" : "p5FQAt9jFVfc",
"ParentHierarchyNode" : "1PUsJdMs7rSUpN5X",
"HierarchyLevel" : "6",
"VoucherCategoryId" : "5",
"Label" : "GNpkqonvB9x",
"Identifier" : "0eD6or9Q",
"SourceId" : "4",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "tOy6WfDLfzCWiMqo",
"VoucherTypeId" : "1",
"Amount" : "5727255.863",
"PointCost" : "28",
"LoyaltyCardTypeId" : "7",
"VoucherExpirationDelayDay" : "62",
"VoucherExpirationDelayMonth" : "26",
"VoucherExpirationDelayYear" : "6"
},
...
]
Select VoucherCategory by Id
https://customerapi.fts-crm360.com/data/VoucherCategories(9)
HttpMethod : GET
Json Result :
{
"HierarchyNode" : "b6V2sQO9yQYxI",
"ParentHierarchyNode" : "t8B4upWBivWF",
"HierarchyLevel" : "7",
"VoucherCategoryId" : "2",
"Label" : "e3i wFRUxWReM74E",
"Identifier" : "rDiUptgZOZXkgl",
"SourceId" : "5",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "SY0xYab",
"VoucherTypeId" : "6",
"Amount" : "3552216.774",
"PointCost" : "71",
"LoyaltyCardTypeId" : "6",
"VoucherExpirationDelayDay" : "46",
"VoucherExpirationDelayMonth" : "84",
"VoucherExpirationDelayYear" : "17"
}
Create a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories()
HttpMethod : POST
Json Post :
{
"HierarchyNode" : "lgr4v",
"ParentHierarchyNode" : "vyd pfP3",
"HierarchyLevel" : "3",
"Label" : "GrZKDPETt50MxX",
"Identifier" : "bNyL1ui3 ypqIbI",
"SourceId" : "4",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "Eiwb 8",
"VoucherTypeId" : "4",
"Amount" : "4428461.132",
"PointCost" : "29",
"LoyaltyCardTypeId" : "5",
"VoucherExpirationDelayDay" : "69",
"VoucherExpirationDelayMonth" : "46",
"VoucherExpirationDelayYear" : "90"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(9)
HttpMethod : PUT
Json Post :
{
"HierarchyNode" : "zYYZj62jeAGsz",
"ParentHierarchyNode" : "N00aWYCkOoj2O19GnK",
"HierarchyLevel" : "9",
"VoucherCategoryId" : "9",
"Label" : "mixef",
"Identifier" : "VYbTSTNDm1AhKv",
"SourceId" : "8",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "Dosg5dgz 6mSC61",
"VoucherTypeId" : "7",
"Amount" : "7284361.843",
"PointCost" : "60",
"LoyaltyCardTypeId" : "6",
"VoucherExpirationDelayDay" : "82",
"VoucherExpirationDelayMonth" : "21",
"VoucherExpirationDelayYear" : "25"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(9)
HttpMethod : PATCH
Json Post :
{
"VoucherCategoryPath" : "yxa14zd8ydT",
"VoucherExpirationDelayYear" : "29",
"ParentHierarchyNode" : "UzEqZBnX uf",
"VoucherExpirationDelayDay" : "63",
"VoucherExpirationDelayMonth" : "91",
"SourceId" : "2"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(9)
HttpMethod : DELETE
Translate a VoucherCategory label
https://customerapi.fts-crm360.com/data/VoucherCategories(9)/Label
HttpMethod : GET
Required Fields :
Http Header for language : X-Crm360Api-Language-3